numberformat.htmlHTMLudogqπùΔ£πùΔ£ÅʼnY Monkeybread Realbasic plugin - Documentation - NumberFormat

MBS Plugin Documentation

This is the documentation for the Realbasic Plugins from Monkeybreadsoftware.de. You find these plugins and the newest version of this document at http://www.monkeybreadsoftware.de/realbasic inside the plugins section.

This help was last updated on Freitag, 6. September 2002 and covers 2136 items: 126 classes, 2 controls and 583 global functions.

The list of the themes Global methods by category Global methods by name The list of the classes The list of the controls

class NumberFormat
class, Currency, Date and Time Format Mo, 19. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Does nothing.
Function: The number format settings on Mac OS.

CurrencyFormatFlags as integer
property, Currency, Date and Time Format Mo, 19. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: -> 0.
Function: The string used for the currency.
Notes:
Part of the currency format definition. The four least significant bits are unused. The four most significant bits are Boolean values. Bit 7 determines whether there is a leading integer zero; for example, a 1 in this field specifies a format like 0.23, whereas a 0 specifies .23.
Bit 6 determines whether there are trailing decimal zeros; for example, a 1 in this field specifies a format like 325.00, whereas a 0 specifies 325. Bit 5 determines whether to use a minus sign or parentheses to denote a negative currency amount; for example,
a 1 in this field specifies a format like -0.45, whereas a 0 specifies (0.45). Bit 4 determines whether the currency symbol trails or leads; for example, a value of 1 in this field specifies a format like the $3.00 used in the United States, whereas a value of 0 specifies the
3 DM. used in Germany.

You can use the following predefined constants as masks to set or test the bits in the currFmt field:

ConstantValueExplanation
currSymLead16Currency symbol leads
currNegSym32Use minus sign for negative
currTrailingZ64Use trailing decimal zeros
currLeadingZ128Use leading integer zero

CurrencySymbol as string
property, Currency, Date and Time Format Mo, 19. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: -> "".
Function: The string used for the currency.
Notes: One to three characters long.

CurrencySymbolLeads as boolean
property, Currency, Date and Time Format Mo, 19. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: -> false.
Function: Currency symbol leads?
Notes: See CurrencyFormatFlags for details.

DateOrder as string
property, Currency, Date and Time Format Mo, 19. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: -> "".
Function: The order of day, month and year for short day.
Notes: e.g. dmy for Germany.

DateSeparator as string
property, Currency, Date and Time Format Mo, 19. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: -> "".
Function: The 1-byte character that separates the different parts of the date.
Notes: For example, in the United States this character is a slash (12/3/46), in Italy it is a hyphen (3-12-46), and in Japan it is a decimal point (46.12.3)

DecimalPoint as string
property, Currency, Date and Time Format Mo, 19. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: -> "".
Function: The string used for decimal separator.
Notes: One character long.

EveningPrefix as string
property, Currency, Date and Time Format Mo, 19. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: -> "".
Function: The Prefix for the time in the evening.

EveningSuffix as string
property, Currency, Date and Time Format Mo, 19. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: -> "".
Function: The Suffix for the time in the evening.
Notes: e.g. "PM" in the USA.

Inches as boolean
property, Currency, Date and Time Format Mo, 19. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: -> false.
Function: Are we using inches system?

LeadingZeroForHours as boolean
property, Currency, Date and Time Format Mo, 19. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: -> false.
Function: Use leading zero for hours?
Notes: See TimeFormat for details.

LeadingZeroForMinutes as boolean
property, Currency, Date and Time Format Mo, 19. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: -> false.
Function: Use leading zero for minutes?
Notes: See TimeFormat for details.

LeadingZeroForSeconds as boolean
property, Currency, Date and Time Format Mo, 19. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: -> false.
Function: Use leading zero for seconds?
Notes: See TimeFormat for details.

ListSeparator as string
property, Currency, Date and Time Format Mo, 19. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: -> "".
Function: The string used for list separator.
Notes: One character long.

Metric as boolean
property, Currency, Date and Time Format Mo, 19. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: -> false.
Function: Are we using metric system?

MorningPrefix as string
property, Currency, Date and Time Format Mo, 19. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: -> "".
Function: The Prefix for the time in the morning.

MorningSuffix as string
property, Currency, Date and Time Format Mo, 19. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: -> "".
Function: The Suffix for the time in the morning.
Notes: e.g. "AM" in the USA.

Ok as boolean
property, Currency, Date and Time Format Mo, 19. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: -> false.
Function: Are the settings ok?
Notes:
If you make a new instance of the class the values are placed into this object and ok shows you if this worked.
So ok is false on Windows.

ShortDateFormatFlags as integer
property, Currency, Date and Time Format Mo, 19. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: -> 0.
Function: The flags for the short date format.
Notes:
The five least significant bits are unused. The three most significant bit fields are Boolean values that determine whether to show the century, and whether to show leading zeros in month and day numbers. For example, if the first bit is set to 1 it specifies a date format like 10/21/1917, and set to 0 specifies the format 10/21/17. The second bit set to 1 specifies a format like 05/23/84, and set to 0 specifies the format 5/23/84. The third bit set to 1 specifies a format like 12/03/46, and set to 0 specifies the format 12/3/46.

To set or test the bits in the shrtDateFmt field, you can use the following predefined constants as masks:
ConstantValueExplanation
dayLdingZ32Show leading zero for day
mntLdingZ64Show leading zero for month
century128Show century

ShowCentury as boolean
property, Currency, Date and Time Format Mo, 19. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: -> false.
Function: Show century?
Notes: See ShortDateFormatFlags for details.

ShowLeadingZeroForDay as boolean
property, Currency, Date and Time Format Mo, 19. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: -> false.
Function: Show leading zero for day?
Notes: See ShortDateFormatFlags for details.

ShowLeadingZeroForMonth as boolean
property, Currency, Date and Time Format Mo, 19. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: -> false.
Function: Show leading zero for month?
Notes: See ShortDateFormatFlags for details.

ThousandSeparator as string
property, Currency, Date and Time Format Mo, 19. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: -> "".
Function: The string used for thousand separator.
Notes: One character long.

TimeCycle as integer
property, Currency, Date and Time Format Mo, 19. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: -> 0.
Function: Indicates the time cycle.
Notes:
Indicates the time cycle--that is, whether to use 12 or 24 hours as the basis of time, and whether to consider midnight and noon to be 12:00 or 0:00. You can use the following predefined constants to specify the time cycle:
ConstantValueExplanation
timeCycle240Use 24-hour format(midnight = 0:00)
timeCycleZero1Use A.M./P.M. format(midnight and noon = 0:00)
timeCycle12255Use A.M./P.M. format(midnight and noon = 12:00)

TimeFormat as integer
property, Currency, Date and Time Format Mo, 19. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: -> 0.
Function: The time format flags.
Notes:
Indicates whether to show leading zeros in time representation. Bit 5 determines whether there are leading zeros in seconds; for example, a value of 1 in this field specifies a format like 11:15:05, whereas a 0 specifies the format 11:15:5. Bit 6 determines whether there are leading zeros in minutes; for example, a value of 1 in this field specifies a format like 10:05, whereas a 0 specifies the format 10:5. Bit 7 determines whether there are leading zeros in hours; for example, a value of 1 in this field specifies a format like 09:15, whereas a 0 specifies the format 9:15.

You can use the following predefined constants as masks for setting or testing bits in the time format field:
ConstantValueExplanation
secLeadingZ32Use leading zero for seconds
minLeadingZ64Use leading zero for minutes
hrLeadingZ128Use leading zero for hours

TimeSeparator as string
property, Currency, Date and Time Format Mo, 19. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: -> "".
Function: The string used for time separator.
Notes: The 1-byte character that is the time separator (for example, the colon).

UseLeadingIntegerZero as boolean
property, Currency, Date and Time Format Mo, 19. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: -> false.
Function: Use leading integer zero?
Notes: See CurrencyFormatFlags for details.

UseNegativeSymbolForCurrency as boolean
property, Currency, Date and Time Format Mo, 19. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: -> false.
Function: Use minus sign for negative?
Notes: See CurrencyFormatFlags for details.

UseTrailingDecimalZero as boolean
property, Currency, Date and Time Format Mo, 19. Aug 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: -> false.
Function: Use trailing decimal zeros?
Notes: See CurrencyFormatFlags for details.

Contact

Written 2002 by Christian Schmitz. Feel free to ask or report mistakes to realbasic@macsw.de.
Thanks.

This resource fork intentionally left blank ˇˇ